Is it a good practice by commenting with owner name? [closed]
Posted
by
fifth
on Programmers
See other posts from Programmers
or by fifth
Published on 2011-12-21T03:28:53Z
Indexed on
2012/09/17
21:52 UTC
Read the original article
Hit count: 149
comments
Possible Duplicate:
How do you keep track of the authors of code?
Here's several scenarios which may comment with owner name:
- bug fixing, i.e.
// fixed bug 123 by xxx, solution is ... ...
- fixme/todo tags, i.e.
// TODO: .... by xxx.
- hacks, i.e.
// HACK! ... by xxx
For case #2, please refer to Comment Tags
The obvious advantage is that we can ease tracking by names. The downside is the risk of abuse. Actually my previous company allowed this way of commenting style, but current employer completely disallows names appearing in code.
In my opinion, I would vote for discreetly commenting with author names. I'm open to hear from you if this commenting style is good or bad. Thanks.
© Programmers or respective owner